/*
 * Copyright (C) 2011 by Fabien Barbero
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.flickr.api.collections;

import com.flickr.api.IdentifiedObject;
import com.flickr.api.LocalCache;
import java.awt.image.BufferedImage;
import java.net.URL;
import java.util.List;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlTransient;

/**
 *
 * @author Fabien Barbero
 */
public class Collection implements IdentifiedObject {
    
    @XmlAttribute(name="id")
    private String id;

    @XmlAttribute(name="title")
    private String title;
    
    @XmlAttribute(name="description")
    private String description;
    
    @XmlAttribute(name="iconlarge")
    private URL iconlarge;
    
    @XmlAttribute(name="iconsmall")
    private URL iconsmall;

    @XmlElement(name="set")
    private List<Collection> subCollections;
    
    @XmlTransient
    private LocalCache cache;
    
    void setCache(LocalCache cache) {
        this.cache = cache;
    }
    
    @Override
    public String getId() {
        return id;
    }
    
    /**
     * Get the large image of the collection.
     * @return The large image.
     */
    public BufferedImage getLargeIcon() {
        return cache.getImage(iconlarge);
    }
    
    /**
     * Get the small image of the collection.
     * @return The small image.
     */
    public synchronized BufferedImage getSmallIcon() {
        return cache.getImage(iconsmall);
    }

    /**
     * Get the description of the collection.
     * @return The description.
     */
    public String getDescription() {
        return description;
    }

    /**
     * Get the sub collections.
     * @return The sub collections.
     */
    public List<Collection> getSubCollections() {
        return subCollections;
    }

    /**
     * Get the title of the description.
     * @return The description.
     */
    public String getTitle() {
        return title;
    }
    
}
